JxBrowser/com.teamdev.jxbrowser.dom/[jvm]Element

Element

interface Element : Node

An HTML DOM element.

All HTML element interfaces derive from this interface.

Inheritors

Types

AlignTo

enum AlignTo

Describes how the element will be aligned to the visible area of the scrollable ancestor.

Properties

attributes

val Element.attributes: ElementAttributes

Returns HTML attributes of this element.

innerHtml

val Element.innerHtml: String

Returns a string with the HTML content of this element, or an empty string if the element does not have inner HTML.

innerText

val Element.innerText: String

Returns a string with the content of the element and its descendants, or an empty string if this element does not have a content.

nextSibling

val Node.nextSibling: Node?

Returns the next node in the document tree, if any.

outerHtml

val Element.outerHtml: String

Returns a string with the HTML serialization of this element and its descendants.

parent

val Node.parent: Node?

Returns the parent of this node, if any.

previousSibling

val Node.previousSibling: Node?

Returns the previous node in the document tree, if any.

xPath

val Node.xPath: XPathExpression

Returns XPathExpression that represents path to this Node, or an empty expression if it is not available.

Functions

addEventListener

abstract fun addEventListener(eventType: EventType, listener: Observer<Event>, useCapture: Boolean)

Adds the given listener to the event target.

appendChild

abstract fun appendChild(childNode: Node): Boolean

Adds the given node as a child of the current node to the end of its children list.

attributes

abstract fun attributes(): ElementAttributes

Returns HTML attributes of this element.

blur

abstract fun blur()

Removes keyboard focus from the current element.

boundingClientRect

abstract fun boundingClientRect(): Rect

Returns the rectangle bounds of the element and its position relative to the top-left of the viewport of the current document.

children

abstract fun children(): List<Node>

Returns an immutable list of all children of this node.

click

abstract fun click()

Simulates a click on the node.

abstract fun close()

Closes this node.

compareDocumentPosition

abstract fun compareDocumentPosition(otherNode: Node): Set<DocumentPosition>

Compares position of the current node against another node in a DOM tree.

dispatch

abstract fun dispatch(event: Event): Boolean

Dispatches the given event at the current event target.

document

abstract fun document(): Document

Returns the Document instance of this node.

evaluate

abstract fun evaluate(expression: String): XPathResult

Evaluates the given XPath expression for the node and returns the XPathResult of the ANY type.

abstract fun evaluate(expression: String, type: XPathResultType): XPathResult

Evaluates the given XPath expression for the node and returns the XPathResult object of the given type.

evaluate

fun Node.evaluate(expression: XPathExpression): XPathResult

Evaluates the given expression for the node and returns XPathResult of the XPathResultType.ANY type.

fun Node.evaluate(expression: XPathExpression, type: <Error class: unknown class>): XPathResult

Evaluates the given expression for the node and returns XPathResult of the given type.

eventListeners

abstract fun eventListeners(eventType: EventType, useCapture: Boolean): List<Observer<Event>>

Returns the immutable list of event listeners that listen events of the given


eventType

in a phase that corresponds the given useCapture.

findByClassName

fun SearchContext.findByClassName(className: String): Element?

Returns the first Element found in the current search context by the given className, if any.

findByCssSelector

fun SearchContext.findByCssSelector(cssSelector: String): Element?

Returns the first Element found in the current search context by the given cssSelector, if any.

findById

fun SearchContext.findById(id: String): Element?

Returns the first Element found in the current search context by the given id, if any.

findByName

fun SearchContext.findByName(name: String): Element?

Returns the first Element found in the current search context by the given name, if any.

findByTagName

fun SearchContext.findByTagName(tagName: String): Element?

Returns the first Element found in the current search context by the given tagName, if any.

findElementByClassName

abstract fun findElementByClassName(className: String): Optional<Element>

Returns the first Element object found in the current search context by the given className.

findElementByCssSelector

abstract fun findElementByCssSelector(cssSelector: String): Optional<Element>

Returns the first Element object found in the current search context by the given cssSelector.

findElementById

abstract fun findElementById(id: String): Optional<Element>

Returns the first Element object found in the current search context by the given id.

findElementByName

abstract fun findElementByName(name: String): Optional<Element>

Returns the first Element object found in the current search context by the given name.

findElementByTagName

abstract fun findElementByTagName(tagName: String): Optional<Element>

Returns the first Element object found in the current search context by the given tagName.

findElementsByClassName

abstract fun findElementsByClassName(className: String): List<Element>

Returns an immutable list of the Element objects found in the current search context by the given className.

findElementsByCssSelector

abstract fun findElementsByCssSelector(cssSelector: String): List<Element>

Returns an immutable list of the Element objects found in the current search context by the given cssSelector.

findElementsById

abstract fun findElementsById(id: String): List<Element>

Returns an immutable list of the Element objects found in the current search context by the given id.

findElementsByName

abstract fun findElementsByName(name: String): List<Element>

Returns an immutable list of the Element objects found in the current search context by the given name.

findElementsByTagName

abstract fun findElementsByTagName(tagName: String): List<Element>

Returns an immutable list of the Element objects found in the current search context by the given tagName.

focus

abstract fun focus()

Sets focus on this element, if it can be focused.

getByClassName

fun SearchContext.getByClassName(className: String): Element

Returns the first Element found in the current search context by the given className.

getByCssSelector

fun SearchContext.getByCssSelector(cssSelector: String): Element

Returns the first Element found in the current search context by the given cssSelector.

getById

fun SearchContext.getById(id: String): Element

Returns the first Element found in the current search context by the given id.

getByName

fun SearchContext.getByName(name: String): Element

Returns the first Element found in the current search context by the given name.

getByTagName

fun SearchContext.getByTagName(tagName: String): Element

Returns the first Element found in the current search context by the given tagName.

innerHtml

abstract fun innerHtml(): String

Returns a string with the HTML content of this element, or an empty string if the element does not have inner HTML.

abstract fun innerHtml(html: String): Boolean

Replaces the HTML content of this element with the given html.

innerText

abstract fun innerText(): String

Returns a string with the text content of the element and its descendants.

abstract fun innerText(innerText: String): Boolean

Replaces the text content of the element with the given innerText value.

insertChild

abstract fun insertChild(node: Node, beforeNode: Node): Boolean

Inserts the given node before the given beforeNode as a child of the current node.

nextSibling

abstract fun nextSibling(): Optional<Node>

Returns an Optional that contains the next node in the document tree if such a node exists, otherwise returns an empty Optional.

nodeName

abstract fun nodeName(): String

Returns a string that represents the node name in the UTF8 format.

nodeValue

abstract fun nodeValue(): String

Returns a string that represents the node value.

abstract fun nodeValue(value: String)

Updates the node value with the given new value.

outerHtml

abstract fun outerHtml(): String

Returns a string with the HTML serialization of this element and its descendants.

abstract fun outerHtml(html: String): Boolean

Replaces the element and all of its descendants with a new DOM tree constructed by parsing the given html.

parent

abstract fun parent(): Optional<Node>

Returns an Optional that contains the parent of this node.

previousSibling

abstract fun previousSibling(): Optional<Node>

Returns an Optional that contains the previous node in the document tree if such a node exists, otherwise returns an empty Optional.

removeChild

abstract fun removeChild(childNode: Node): Boolean

Removes the given childNode of the current node from the DOM.

removeEventListener

abstract fun removeEventListener(eventType: EventType, listener: Observer<Event>, useCapture: Boolean)

Removes the given listener from the event target.

replaceChild

abstract fun replaceChild(newNode: Node, oldNode: Node): Boolean

Replaces the given child oldNode of the current node with the given newNode.

scrollIntoView

abstract fun scrollIntoView(alignTo: Element.AlignTo)

Scrolls the element's parent container such that the element on which this method is called is visible to the user.

textContent

abstract fun textContent(): String

Returns the text content of the current node and its descendants.

abstract fun textContent(textContent: String)

Removes all the current node children and replaces them with a single text node with the given textContent.

type

abstract fun type(): NodeType

Returns the node type.

xPath

abstract fun xPath(): String

Returns a string that represents XPath to the current Node or an empty string if it is not available.